Inside Macintosh: QuickTime /

Chapter 2 - Movie Toolbox / Movie Toolbox Reference

Functions That Modify Movie Properties / Working With Movie Spatial Characteristics

GetMovieClipRgn

The GetMovieClipRgn function allows your application to determine a movie's clipping region.

pascal RgnHandle GetMovieClipRgn (Movie theMovie);

theMovie

Specifies the movie for this operation. Your application obtains this movie identifier from such functions as NewMovie, NewMovieFromFile, and NewMovieFromHandle (described on page 2-80, page 2-76, and page 2-78, respectively).

DESCRIPTION

The clipping region defines any clipping that is applied to the movie before it is mapped to its graphics world by applying the movie's matrix. The clipping region is in the movie's display coordinate system and is valid for the entire duration of the movie.

The GetMovieClipRgn function allocates the region and returns a handle to the region. Your application must dispose of this region when you are done with it. If the function could not satisfy your request or if there is no clipping region defined for the movie, it sets the returned handle to nil.

The clipping region is saved with the movie when your application saves the movie.

ERROR CODES

invalidMovie

-2010

This movie is corrupted or invalid

Memory Manager errors

SEE ALSO

You can set the clipping region by calling the SetMovieClipRgn function, which is described in the previous section.